如何使用ALIYUN::OOS::SecretParameter类型创建加密参数

ALIYUN::OOS::SecretParameter类型用于创建一个加密参数。

语法

{
  "Type": "ALIYUN::OOS::SecretParameter",
  "Properties": {
    "Description": String,
    "Constraints": Map,
    "ResourceGroupId": String,
    "SecretParameterName": String,
    "Value": String,
    "KeyId": String,
    "Tags": List
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
Description	String	否	是	参数的描述信息。	长度限制为200字符。
Constraints	Map	否	否	参数的约束条件。	取值： AllowedValues：参数允许值，数组类型的字符串。 AllowedPattern：正则字符串。 MinLength：参数最小长度。 MaxLength：参数最大长度。
ResourceGroupId	String	否	是	资源组ID。	无
SecretParameterName	String	是	否	参数名称。	内容限制为字母、数字、中划线、下划线，长度不能超过180字符，且不能以`ALIYUN`、`ACS`、`ALIBABA`、`ALICLOUD`、`OOS`开头。
Value	String	是	是	参数内容。	长度限制为4096。
KeyId	String	否	否	加密使用的KMS的KeyId。	无
Tags	List	否	是	自定义标签。	最多支持添加20个标签。更多信息，请参见Tags属性。

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称	类型	必须	允许更新	描述	约束
Value	String	否	否	标签值。	长度为0~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。
Key	String	是	否	标签键。	长度为1~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。

返回值

Fn::GetAtt

Description：参数的描述信息。
CreatedBy：参数创建者。
ResourceGroupId：参数的资源组ID。
SecretParameterName：参数名称。
UpdatedDate：参数更新时间。
CreateTime：参数创建时间。
KeyId：加密使用的KMS的KeyId。
SecretParameterId：参数ID。
UpdatedBy：参数更新者。
Type：参数类型。
Constraints：参数约束条件。
ParameterVersion：参数版本号。
Tags：标签。
ShareType：参数共享类型。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::OOS::SecretParameter
    Properties:
      Constraints: '{"AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
      SecretParameterName: MySecretParameter
      Value: SecretParameter
      KeyId: 80e9409f-78fa-42ab-84bd-83f40c******
Outputs:
  Description:
    Description: The description of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  CreatedBy:
    Description: The user who created the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreatedBy
  ResourceGroupId:
    Description: The ID of resource group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  SecretParameterName:
    Description: The name of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecretParameterName
  UpdatedDate:
    Description: The time when the encryption parameter was updated.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdatedDate
  CreateTime:
    Description: The time when the encryption parameter was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  KeyId:
    Description: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - KeyId
  SecretParameterId:
    Description: The ID of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecretParameterId
  UpdatedBy:
    Description: The user who updated the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdatedBy
  Type:
    Description: The data type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Type
  Constraints:
    Description: The constraints of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Constraints
  ParameterVersion:
    Description: The version number of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterVersion
  Tags:
    Description: Tags of encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
  ShareType:
    Description: The share type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ShareType

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::OOS::SecretParameter",
      "Properties": {
        "Constraints": "{\"AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\"secretparameter\",\"MinLength\":0,\"MaxLength\":20}",
        "SecretParameterName": "MySecretParameter",
        "Value": "SecretParameter",
        "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******"
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "CreatedBy": {
      "Description": "The user who created the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreatedBy"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "SecretParameterName": {
      "Description": "The name of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecretParameterName"
        ]
      }
    },
    "UpdatedDate": {
      "Description": "The time when the encryption parameter was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedDate"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the encryption parameter was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "KeyId": {
      "Description": "The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "KeyId"
        ]
      }
    },
    "SecretParameterId": {
      "Description": "The ID of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecretParameterId"
        ]
      }
    },
    "UpdatedBy": {
      "Description": "The user who updated the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedBy"
        ]
      }
    },
    "Type": {
      "Description": "The data type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Type"
        ]
      }
    },
    "Constraints": {
      "Description": "The constraints of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Constraints"
        ]
      }
    },
    "ParameterVersion": {
      "Description": "The version number of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterVersion"
        ]
      }
    },
    "Tags": {
      "Description": "Tags of encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ShareType"
        ]
      }
    }
  }
}